CPU and Max RSS Analysis tools #2100

ChrisPaulBennett · 2025-03-12T09:14:15Z

This apart of 3 pull requests for adding CPU time and Max RSS analysis to the Cylc UI.

This adds the Max RSS and CPU time (as measured by cgroups) to the table view, box plot and time series views.

Linked to;
cylc/cylc-flow#6663
cylc/cylc-uiserver#675

Check List

I have read CONTRIBUTING.md and added my name as a Code Contributor.
Contains logically grouped changes (else tidy your branch by rebase).
Does not contain off-topic changes (use other PRs for other changes).
Applied any dependency changes to both setup.cfg (and conda-environment.yml if present).
Tests are included (or explain why tests are not needed).
Changelog entry included if this is a change that can affect users
Cylc-Doc pull request opened if required at cylc/cylc-doc/pull/XXXX.
If this is a bug fix, PR should be raised against the relevant ?.?.x branch.

Fixed bug memory values

Tests added

MetRonnie · 2025-04-02T15:06:16Z

We'll get round to this when we can, but a little bit swamped at the moment!

wxtim · 2025-04-16T12:11:55Z

I've had a first look -

The "chips" look good:

Is there a reason I don't get maxrss for the hpc background job?
Might these be more useful if the data was converted to human readable?

If nothing has finished the analysis view sticks in this state:

I threw a fairly nasty workflow at it and noticed some anomalies:

Cannot page through, cannot see tasks I know to have completed.

ChrisPaulBennett · 2025-04-22T14:27:22Z

Oliver recommended the best way to move data around cylc was to use a debug message. Those chips only only appear in dev mode and won't be visible to normal users.
What's a HPC background job?
The analysis view being stuck in that state was introduced when I merged in @oliver-sanders changes to SQL. I haven't figured out what is causing this yet. Clicking refresh will solve the issue.

wxtim · 2025-04-23T10:28:18Z

What's a HPC background job?

Using the supercomputer login node as just another computer. We use the term background to mean execution a job in bash without using a job runner like PBS or Slurm.

E.g. > ssh exab bash program.sh rather than ssh exab qsub program.sh

Warning

Irrelevant
@oliver-sanders pointed out to me after I posted the original comment that background jobs don't use cgroups in the same way, so the profiler probably won't work for them anyway.

oliver-sanders · 2025-04-23T10:54:53Z

Is there a reason I don't get maxrss for the hpc background job?

You would need to configure this platform to run the profiler.
There are no cgroups to poll for background jobs so it wouldn't work if you tried.

Those chips only only appear in dev mode and won't be visible to normal users.

Debug is def the right level to send these messages at, however, I'm not sure we've got the UI to hide debug level messages yet. Orthogonal to this PR either way.

MetRonnie · 2025-06-13T11:55:09Z

src/utils/tasks.js

+  // If memory value passed
+  } else if (timingOption === 'maxRss') {
+    if (value < 5000) {
+      const kilobytes = value
+      return kilobytes.toPrecision(3) + ' KB'
+    } else if (value / 1024 < 1000) {
+      const megabytes = value / 1024
+      return megabytes.toPrecision(3) + ' MB'
+    } else {
+      const gigabytes = value / 1048576
+      return gigabytes.toPrecision(3) + ' GB'
+    }


IMO this ought to be in a different function as it's not a duration

Actually, I think the name of the function should be change. Originally, when we only had timing on the analysis view, this function displayed the timings in a sensible format.
It's ensuring the appropriate scale, for the appropriate unit is displayed on the Y-axis. Wouldn't make sense to have two functions doing that.
formatUnits() ?

formatDuration is used by other components such as the Tree and Table views, so it needs to stay.

Not sure I get you?
The the function won't change. I'm just changing the name to better reflect it's purpose

Its purpose should remain as formatting durations. I would add a new function for formatting RSS. If you want you could also have a function like

function formatUnits (...) { if (duration) formatDuration(...) else formatRSS(...) }

src/views/Analysis.vue

src/components/cylc/analysis/AnalysisTable.vue

Remove reference to 'suite' Co-authored-by: Ronnie Dutta <[email protected]>

…y_logging

Co-authored-by: Ronnie Dutta <[email protected]>

src/utils/tasks.js

MetRonnie · 2025-07-14T16:38:39Z

src/utils/tasks.js

+  // If memory value passed
+  } else if (timingOption === 'maxRss') {
+    if (value < 5000) {
+      const kilobytes = value
+      return kilobytes.toPrecision(3) + ' KB'
+    } else if (value / 1024 < 1000) {
+      const megabytes = value / 1024
+      return megabytes.toPrecision(3) + ' MB'
+    } else {
+      const gigabytes = value / 1048576
+      return gigabytes.toPrecision(3) + ' GB'
+    }


formatDuration is used by other components such as the Tree and Table views, so it needs to stay.

MetRonnie · 2025-07-14T17:08:18Z

src/components/cylc/analysis/BoxPlot.vue

-        { title: `Min ${this.timingOption} time`, value: `min${upperFirst(this.timingOption)}Time` },
-        { title: `Max ${this.timingOption} time`, value: `max${upperFirst(this.timingOption)}Time` },
+        { title: `Mean ${formatChartLabels(this.timingOption)}`, value: `mean${upperFirst(getTimingOption(this.timingOption))}` },
+        { title: `Median ${formatChartLabels(this.timingOption)}`, value: `median${upperFirst(getTimingOption(this.timingOption))}` },


Not sure what is happening here but in the offline mode, sorting by median time is not working for any metric

Possibly missing from offline data?

Conciseness Co-authored-by: Ronnie Dutta <[email protected]>

# Conflicts: # src/views/Analysis.vue

ChrisPaulBennett added 5 commits March 10, 2025 15:50

CPU/Memory logging working

939ac5f

Time series now working

0bdd49a

Fixed Chart Labels

f49aa12

Added "Total of Totals" for CPU time.

75b9add

Fixed bug memory values

Time series Y axis labels fixed.

33f24db

Tests added

ChrisPaulBennett requested review from oliver-sanders and MetRonnie March 12, 2025 09:14

Removed console.log commands

00c5c56

ChrisPaulBennett marked this pull request as draft March 12, 2025 09:38

oliver-sanders added this to the Pending milestone Mar 12, 2025

oliver-sanders assigned ChrisPaulBennett Mar 12, 2025

This comment was marked as resolved.

Sign in to view

Updated formatDuration to properly handle the lack of optional arguments

c5f8cb4

ChrisPaulBennett force-pushed the memory_logging branch from af6ee22 to c5f8cb4 Compare March 12, 2025 11:19

This was referenced Mar 13, 2025

CPU and Max RSS Analysis tools cylc/cylc-flow#6663

Open

CPU and Max RSS Analysis tools cylc/cylc-uiserver#675

Open

ChrisPaulBennett marked this pull request as ready for review April 2, 2025 13:21

Adding towncrier fragment

d9c8ed3

Merge branch 'refs/heads/origin-master' into memory_logging

04c59fa

oliver-sanders added the analysis views Work pertaining to the analysis/gantt/etc views label May 20, 2025

Merge branch 'master' into memory_logging

eceb33b

MetRonnie reviewed Jun 13, 2025

View reviewed changes

ChrisPaulBennett and others added 3 commits July 11, 2025 14:26

Update src/views/Analysis.vue

1c7aca8

Remove reference to 'suite' Co-authored-by: Ronnie Dutta <[email protected]>

Refactoring loop

36db262

Merge remote-tracking branch 'cylc_ui_fork/memory_logging' into memor…

b98ae2b

…y_logging

ChrisPaulBennett and others added 2 commits July 11, 2025 15:25

Update src/views/Analysis.vue

3de0518

Co-authored-by: Ronnie Dutta <[email protected]>

Adding unit test coverage

be7836f

MetRonnie reviewed Jul 14, 2025

View reviewed changes

ChrisPaulBennett and others added 5 commits July 18, 2025 11:27

Update src/utils/tasks.js

e8133d0

Conciseness Co-authored-by: Ronnie Dutta <[email protected]>

Merge branch 'refs/heads/master' into memory_logging

1e60a84

# Conflicts: # src/views/Analysis.vue

Code review changes

a216ce3

Merge branch 'refs/heads/master' into memory_logging

65d3aac

Changed table view behaviour to allow zeros

7812385

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

CPU and Max RSS Analysis tools #2100

CPU and Max RSS Analysis tools #2100

ChrisPaulBennett commented Mar 12, 2025 •

edited

Loading

Uh oh!

This comment was marked as resolved.

MetRonnie commented Apr 2, 2025

Uh oh!

wxtim commented Apr 16, 2025 •

edited

Loading

Uh oh!

ChrisPaulBennett commented Apr 22, 2025

Uh oh!

wxtim commented Apr 23, 2025 •

edited

Loading

Uh oh!

oliver-sanders commented Apr 23, 2025 •

edited

Loading

Uh oh!

MetRonnie Jun 13, 2025

Uh oh!

ChrisPaulBennett Jul 11, 2025

Uh oh!

MetRonnie Jul 14, 2025

Uh oh!

ChrisPaulBennett Jul 18, 2025

Uh oh!

MetRonnie Jul 18, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MetRonnie Jul 14, 2025

Uh oh!

MetRonnie Jul 14, 2025

Uh oh!

Uh oh!

CPU and Max RSS Analysis tools #2100

Are you sure you want to change the base?

CPU and Max RSS Analysis tools #2100

Conversation

ChrisPaulBennett commented Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as resolved.

MetRonnie commented Apr 2, 2025

Uh oh!

wxtim commented Apr 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ChrisPaulBennett commented Apr 22, 2025

Uh oh!

wxtim commented Apr 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oliver-sanders commented Apr 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MetRonnie Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

ChrisPaulBennett Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

MetRonnie Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

ChrisPaulBennett Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

MetRonnie Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MetRonnie Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

MetRonnie Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ChrisPaulBennett commented Mar 12, 2025 •

edited

Loading

wxtim commented Apr 16, 2025 •

edited

Loading

wxtim commented Apr 23, 2025 •

edited

Loading

oliver-sanders commented Apr 23, 2025 •

edited

Loading